Refine FieldWorks AI review workflows by johnml1135 · Pull Request #905 · sillsdev/FieldWorks

johnml1135 · 2026-05-20T23:47:56Z

Summary

Refines the FieldWorks AI review customization flow into a clearer layered architecture:

Rename challenge-pr-author to pr-preflight for the pre-PR branch readiness workflow.
Keep review-analyzer.instructions.md as the shared FieldWorks review policy, not a user-facing workflow.
Wire pr-preflight to the existing specialist reviewer agents for C#, WinForms, C++/interop, Avalonia, and architecture-risk passes where appropriate.
Integrate grill-with-docs into planning/OpenSpec flows so ambiguous repo language is clarified before proposal/spec/design/task artifacts are written.
Align managed-code review guidance with the repo default C# 8.0 policy and nullable-reference-types disabled by default.
Keep respond-to-review-comments as the post-PR review feedback workflow.
Add a canonical Docs/workflows/ai-pr-workflow.md guide for the Jira -> worktree -> preflight -> review-response path with GitHub Copilot and Claude Code entrypoints.
Link that workflow from ReadMe.md, Docs/core-developer-setup.md, Docs/CONTRIBUTING.md, Docs/workflows/pull-request-workflow.md, and .github/pull_request_template.md so developers can discover it from onboarding and PR authoring surfaces.

Relationship to #865

The AI review workflow work now belongs in this PR. PR #865 should stay focused on non-render build/test/helper/installer cleanup and drop duplicated generic review-skill material.

CI-ready checklist

Commit messages follow .github/commit-guidelines.md; ran CI: Full local check.
No whitespace warnings locally; CI: Full local check reran after whitespace normalization and reported no problems.
Builds/tests pass locally (not run; changes are documentation/customization only).
For any Src/** folders touched, corresponding AGENTS.md files are updated or explicitly confirmed still accurate. Only Src/AGENTS.md guidance was updated to align with the repo C# 8.0 policy.

Notes for reviewers

This PR changes Copilot customization, skills, prompts, context/instruction files, and contributor-facing workflow docs only; no product source, build scripts, installer files, or runtime behavior changed.

This change is

Copilot

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Adds FieldWorks-specific Copilot customization artifacts to standardize PR analysis, pre-PR author “challenge” workflows, and structured response handling for review comments.

Changes:

Added a repo-root CONTEXT.md glossary/invariants document to align terminology across humans and agents.
Introduced new skills/prompts for pre-PR author challenge (challenge-pr-author) and for addressing review feedback (respond-to-review-comments), plus a terminology-grilling skill (grill-with-docs).
Added a FieldWorks-specific review analyzer instruction set and updated repo context entry points.

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
CONTEXT.md	New repo-wide shared language/glossary and invariants for FieldWorks.
.github/skills/respond-to-review-comments/SKILL.md	New workflow skill for triaging/fixing/replying to PR review comments.
.github/skills/grill-with-docs/SKILL.md	New skill for tightening terminology against repo context documents.
.github/skills/challenge-pr-author/SKILL.md	New pre-PR interactive author “challenge” workflow that writes `.review/summary.md`.
.github/prompts/respond-to-review-comments.prompt.md	Prompt wiring to invoke the `respond-to-review-comments` skill.
.github/prompts/challenge-pr-author.prompt.md	Prompt wiring to invoke the `challenge-pr-author` skill.
.github/instructions/review-analyzer.instructions.md	New FieldWorks PR/branch analysis policy with required passes and rubric.
.github/context/codebase.context.md	Adds pointers to `CONTEXT.md` and the new review-response skill.

github-actions · 2026-05-20T23:58:33Z

NUnit Tests

1 files ± 0 1 suites ±0 12m 33s ⏱️ +45s
4 251 tests +41 4 178 ✅ +38 73 💤 +3 0 ❌ ±0
4 260 runs +41 4 187 ✅ +38 73 💤 +3 0 ❌ ±0

Results for commit 243679a. ± Comparison against base commit 53d5dbb.

This pull request removes 2 and adds 43 tests. Note that renamed tests count towards both.

SIL.FieldWorks.Common.RootSites.SimpleRootSiteTests.RenderEngineFactoryTests ‑ get_Renderer_Graphite
SIL.FieldWorks.Common.RootSites.SimpleRootSiteTests.RenderEngineFactoryTests ‑ get_Renderer_Uniscribe

LexTextDllTests.AreaListenerTests ‑ GetToolForList_KnownList_ReturnsConfiguredToolName
LexTextDllTests.AreaListenerTests ‑ GetToolForList_UnknownList_ReturnsCustomToolName
SIL.FieldWorks.Common.FwUtils.FontFeatureSettingsTests ‑ NormalizePreservingLegacy_NormalizesOpenTypeFeatures
SIL.FieldWorks.Common.FwUtils.FontFeatureSettingsTests ‑ NormalizePreservingLegacy_NormalizesOpenTypeFeaturesThatStartWithPunctuation
SIL.FieldWorks.Common.FwUtils.FontFeatureSettingsTests ‑ NormalizePreservingLegacy_PreservesNumericGraphiteFeatureIds
SIL.FieldWorks.Common.FwUtils.FontFeatureSettingsTests ‑ Normalize_ReturnsDeterministicRendererNeutralString
SIL.FieldWorks.Common.FwUtils.FontFeatureSettingsTests ‑ Parse_AcceptsCustomPrintableAsciiTags
SIL.FieldWorks.Common.FwUtils.FontFeatureSettingsTests ‑ Parse_IgnoresInvalidEntries
SIL.FieldWorks.Common.FwUtils.FontFeatureSettingsTests ‑ Parse_LastValueWinsForDuplicateTags
SIL.FieldWorks.Common.FwUtils.FontFeatureSettingsTests ‑ Parse_LogsIgnoredInvalidEntries
…

♻️ This comment has been updated with latest results.

Copilot

Pull request overview

Copilot reviewed 18 out of 18 changed files in this pull request and generated 2 comments.

Add AI PR workflow docs and prompts; introduce pr-preflight and respond-to-review-comments skills; update repo guidance and templates.

jasonleenaylor

@jasonleenaylor partially reviewed 24 files and all commit messages, and made 2 comments.
Reviewable status: complete! all files reviewed, all discussions resolved (waiting on johnml1135).

.github/instructions/review-analyzer.instructions.md line 37 at r2 (raw file):

## Severity Rubric

- **Critical**: Blocks merge. Examples: correctness bug, security issue, native/managed boundary safety issue, breaking public contract or ABI change without compatibility plan, global COM registration/registry hack, build ordering break, CI silently skipping tests, installer behavior that can corrupt install/upgrade/uninstall.

Modify this to say 'Must fix before merge.' I think 'Blocks merge.' is unnecessarily ambiguous.

Code quote:

Blocks merge.

Copilot AI review requested due to automatic review settings May 20, 2026 23:47

Copilot AI reviewed May 20, 2026

View reviewed changes

Comment thread .github/context/codebase.context.md Outdated

Comment thread .github/skills/respond-to-review-comments/SKILL.md Outdated

Comment thread .github/skills/challenge-pr-author/SKILL.md Outdated

Comment thread .github/skills/challenge-pr-author/SKILL.md Outdated

johnml1135 changed the title ~~Add AI review customization workflows~~ Refine FieldWorks AI review workflows May 21, 2026

johnml1135 requested a review from Copilot May 21, 2026 18:53

johnml1135 mentioned this pull request May 21, 2026

Closed: superseded by #908 #865

Closed

Copilot AI reviewed May 21, 2026

View reviewed changes

Comment thread .github/context/codebase.context.md Outdated

Comment thread .github/skills/pr-preflight/SKILL.md Outdated

johnml1135 mentioned this pull request May 21, 2026

chore: improve build, test, and installer reliability #908

Merged

johnml1135 force-pushed the new_skills branch 2 times, most recently from 2da2491 to 7756f98 Compare June 4, 2026 17:48

This comment has been minimized.

Sign in to view

chore: refine FieldWorks AI review workflows

e96ef91

Add AI PR workflow docs and prompts; introduce pr-preflight and respond-to-review-comments skills; update repo guidance and templates.

johnml1135 force-pushed the new_skills branch from 7756f98 to e96ef91 Compare June 4, 2026 17:58

Refine and improve CONTEXT.md

243679a

jasonleenaylor approved these changes Jun 9, 2026

View reviewed changes

jasonleenaylor merged commit e6976c5 into main Jun 9, 2026
8 checks passed

jasonleenaylor deleted the new_skills branch June 9, 2026 20:48

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Refine FieldWorks AI review workflows#905

Refine FieldWorks AI review workflows#905
jasonleenaylor merged 2 commits into
mainfrom
new_skills

johnml1135 commented May 20, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented May 20, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

This comment has been minimized.

jasonleenaylor left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

johnml1135 commented May 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Relationship to #865

CI-ready checklist

Notes for reviewers

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented May 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

NUnit Tests

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

This comment has been minimized.

jasonleenaylor left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

johnml1135 commented May 20, 2026 •

edited

Loading

github-actions Bot commented May 20, 2026 •

edited

Loading